home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / u_man / cat1 / gencat.z / gencat
Encoding:
Text File  |  2002-10-03  |  11.6 KB  |  219 lines

  1.  
  2.  
  3.  
  4. ggggeeeennnnccccaaaatttt((((1111))))                                                            ggggeeeennnnccccaaaatttt((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _gggg_eeee_nnnn_cccc_aaaa_tttt - generate a formatted message catalogue
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _gggg_eeee_nnnn_cccc_aaaa_tttt [_----_mmmm] _c_a_t_f_i_l_e _m_s_g_f_i_l_e  ...
  13.  
  14. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  15.      The _gggg_eeee_nnnn_cccc_aaaa_tttt utility merges the message text source file(s) _m_s_g_f_i_l_e into a
  16.      formatted message database _c_a_t_f_i_l_e.  The database _c_a_t_f_i_l_e will be created
  17.      if it does not already exist.  If _c_a_t_f_i_l_e does exist its messages will be
  18.      included in the new _c_a_t_f_i_l_e.  If set and message numbers collide, the new
  19.      message text defined in _m_s_g_f_i_l_e will replace the old message text
  20.      currently contained in _c_a_t_f_i_l_e.  The message text source file (or set of
  21.      files) input to _gggg_eeee_nnnn_cccc_aaaa_tttt can contain either set and message numbers or
  22.      simply message numbers, in which case the set _NNNN_LLLL______SSSS_EEEE_TTTT_DDDD [see _nnnn_llll______tttt_yyyy_pppp_eeee_ssss(5)]
  23.      is assumed.
  24.  
  25.      The meanings of the options are:
  26.  
  27.      _----_mmmm    Use memory allocated by the _m_a_l_l_o_c() routine, instead of memory
  28.            mapped allocation routine _m_m_a_p().
  29.  
  30.      _----_tttt _t_e_x_t_m_a_x
  31.            This is optional.  This parameter _t_e_x_t_m_a_x allows _gggg_eeee_nnnn_cccc_aaaa_tttt to
  32.            dynamically allocate the message text area.  If not specified, then
  33.            the _NNNN_LLLL______TTTT_EEEE_XXXX_TTTT_MMMM_AAAA_XXXX define is used for the message text length.  If the
  34.            _----_tttt option parameter is present, then the _t_e_x_t_m_a_x input must be a
  35.            decimal number in the range of (0-32767).  If _t_e_x_t_m_a_x is specified
  36.            and is not in the range (0-32767) or is not greater than
  37.            _NNNN_LLLL______TTTT_EEEE_XXXX_TTTT_MMMM_AAAA_XXXX, then the message text length maximum is set to
  38.            _NNNN_LLLL______TTTT_EEEE_XXXX_TTTT_MMMM_AAAA_XXXX.
  39.  
  40.      The format of a message text source file is defined as follows.  Note
  41.      that the fields of a message text source line are separated by a single
  42.      ASCII space or tab character.  Any other ASCII spaces or tabs are
  43.      considered as being part of the subsequent field.
  44.  
  45.      _$$$$_ssss_eeee_tttt  _n _c_o_m_m_e_n_t
  46.           Where _n specifies the set identifier of the following messages until
  47.           the next _$$$$_ssss_eeee_tttt, _$$$$_dddd_eeee_llll_ssss_eeee_tttt or end-of-file appears.  _n must be  a number
  48.           in the range (1-{_NNNN_LLLL______SSSS_EEEE_TTTT_MMMM_AAAA_XXXX}).  Set identifiers within a single
  49.           source file need not be contiguous.  Any string following the set
  50.           identifier is treated as a comment.  If no _$$$$_ssss_eeee_tttt directive is
  51.           specified in a message text source file, all messages will be
  52.           located in the default message set _NNNN_LLLL______SSSS_EEEE_TTTT_DDDD.
  53.  
  54.      _$$$$_dddd_eeee_llll_ssss_eeee_tttt  _n _c_o_m_m_e_n_t
  55.           Deletes message set _n from an existing message catalogue.  Any
  56.           string following the set number is treated as a comment.
  57.           (Note:  if _n is not a valid set, it is ignored.)
  58.  
  59.  
  60.  
  61.                                                                         PPPPaaaaggggeeee 1111
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68. ggggeeeennnnccccaaaatttt((((1111))))                                                            ggggeeeennnnccccaaaatttt((((1111))))
  69.  
  70.  
  71.  
  72.      _$$$$ _c_o_m_m_e_n_t
  73.           A line beginning with a dollar symbol (_$$$$) followed by an ASCII space
  74.           or tab character is treated as a comment.
  75.  
  76.      _m _m_e_s_s_a_g_e _t_e_x_t
  77.           The _m denotes the message identifier, which is a number in the range
  78.           (1-{_NNNN_LLLL______MMMM_SSSS_GGGG_MMMM_AAAA_XXXX}).  The message text is stored in the message
  79.           catalogue with the set identifier specified by the last _$$$$_ssss_eeee_tttt
  80.           directive, and with message identifier _m.  If the message text is
  81.           empty, and an ASCII space or tab field separator is present, an
  82.           empty string is stored in the message catalogue.  If a message
  83.           source line has a message number, but neither a field separator nor
  84.           message text, the existing message with that number (if any) is
  85.           deleted from the catalogue.  Message identifiers need not be
  86.           contiguous.  The length of message text must be in the range
  87.           (0-{_NNNN_LLLL______TTTT_EEEE_XXXX_TTTT_MMMM_AAAA_XXXX}).
  88.  
  89.      _$$$$_qqqq_uuuu_oooo_tttt_eeee _c
  90.           This line specifies an optional quote character _c, which can be used
  91.           to surround message text so that trailing spaces or null (empty)
  92.           messages are visible in a message source line.  By default, or if an
  93.           empty _$$$$_qqqq_uuuu_oooo_tttt_eeee directive is supplied, no quoting of message text will
  94.           be recognized.
  95.  
  96.      Empty lines in a message text source file are ignored.
  97.  
  98.      Text strings can contain the special characters and escape sequences
  99.      defined in the following table:
  100.                     ___________________________________________
  101.                       Description         Symbol     Sequence
  102.                     ___________________________________________
  103.                       newline             NL(LF)     \n
  104.                       horizontal tab      HT         \t
  105.                       vertical tab        VT         \v
  106.                       backspace           BS         \b
  107.                       carriage return     CR         \r
  108.                       form feed           FF         \f
  109.                       backslash           \          \\
  110.                       bit pattern         ddd        \ddd
  111.                     ___________________________________________
  112.                     |||||||||||
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.                                                                |||||||||||
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.      If the character following a backslash is not one of those specified, the
  135.      backslash is ignored.  The escape sequence _\\\\_dddd_dddd_dddd consists of backslash
  136.      followed by 1, 2, or 3 octal digits, which are taken to specify the value
  137.      of the desired character.
  138.  
  139.      Backslash followed by an ASCII newline character is also used to continue
  140.      a string on the following line.  Thus, the following two lines describe a
  141.      single message string:
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.                                                                         PPPPaaaaggggeeee 2222
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155. ggggeeeennnnccccaaaatttt((((1111))))                                                            ggggeeeennnnccccaaaatttt((((1111))))
  156.  
  157.  
  158.  
  159.          _1111 _TTTT_hhhh_iiii_ssss _llll_iiii_nnnn_eeee _cccc_oooo_nnnn_tttt_iiii_nnnn_uuuu_eeee_ssss _\\\\
  160.          _tttt_oooo _tttt_hhhh_eeee _nnnn_eeee_xxxx_tttt _llll_iiii_nnnn_eeee
  161.  
  162.      which is equivalent to:
  163.  
  164.          _1111 _TTTT_hhhh_iiii_ssss _llll_iiii_nnnn_eeee _cccc_oooo_nnnn_tttt_iiii_nnnn_uuuu_eeee_ssss _tttt_oooo _tttt_hhhh_eeee _nnnn_eeee_xxxx_tttt _llll_iiii_nnnn_eeee
  165.  
  166. FFFFIIIILLLLEEEESSSS
  167.      _////_uuuu_ssss_rrrr_////_llll_iiii_bbbb_////_llll_oooo_cccc_aaaa_llll_eeee_////_l_o_c_a_l_e_////_LLLL_CCCC______MMMM_EEEE_SSSS_SSSS_AAAA_GGGG_EEEE_SSSS_////_uuuu_xxxx_mmmm_eeee_ssss_gggg
  168.           language-specific message file [See _LLLL_AAAA_NNNN_GGGG on _eeee_nnnn_vvvv_iiii_rrrr_oooo_nnnn(5).]
  169.  
  170. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  171.      _mmmm_kkkk_mmmm_ssss_gggg_ssss(1), _cccc_aaaa_tttt_oooo_pppp_eeee_nnnn(3C), _cccc_aaaa_tttt_gggg_eeee_tttt_ssss(3C), _cccc_aaaa_tttt_cccc_llll_oooo_ssss_eeee(3C), _gggg_eeee_tttt_tttt_xxxx_tttt(3C),
  172.      _nnnn_llll______tttt_yyyy_pppp_eeee_ssss(5)
  173.  
  174. NNNNOOOOTTTTEEEESSSS
  175.      This version of _gggg_eeee_nnnn_cccc_aaaa_tttt is built on the _mmmm_kkkk_mmmm_ssss_gggg_ssss utility.  The _gggg_eeee_nnnn_cccc_aaaa_tttt
  176.      database consists of two files, _c_a_t_f_i_l_e_...._mmmm, which is a _mmmm_kkkk_mmmm_ssss_gggg_ssss format
  177.      catalogue, and _c_a_t_f_i_l_e, which contains the information required to
  178.      translate a set and message number into a simple message number that can
  179.      be used in a call to _gggg_eeee_tttt_tttt_xxxx_tttt.
  180.  
  181.      Using _gggg_eeee_tttt_tttt_xxxx_tttt constrains the catalogues to be located in a subdirectory
  182.      under _////_uuuu_ssss_rrrr_////_llll_iiii_bbbb_////_llll_oooo_cccc_aaaa_llll_eeee.  This restriction is lifted by placing only a
  183.      symbolic link to the catalogue in the directory
  184.      _////_uuuu_ssss_rrrr_////_llll_iiii_bbbb_////_llll_oooo_cccc_aaaa_llll_eeee_////_XXXX_oooo_pppp_eeee_nnnn_////_LLLL_CCCC______MMMM_EEEE_SSSS_SSSS_AAAA_GGGG_EEEE_SSSS when the catalogue is opened.  It is
  185.      this link that _gggg_eeee_tttt_tttt_xxxx_tttt uses when attempting to access the catalogue.  The
  186.      link is removed when the catalogue is closed but occasionally as
  187.      applications exit abnormally without closing catalogues redundant
  188.      symbolic links will be left in the directory.
  189.  
  190.      For compatibility with previous versions of _gggg_eeee_nnnn_cccc_aaaa_tttt released in a number
  191.      of specialized internationalization products, the _----_mmmm option is supplied.
  192.      This option will cause _gggg_eeee_nnnn_cccc_aaaa_tttt to build a single file _c_a_t_f_i_l_e which is
  193.      compatible with the format catalogues produced by the earlier versions.
  194.      The retrieval routines detect the type of catalogue they are using and
  195.      will act appropriately.
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.                                                                         PPPPaaaaggggeeee 3333
  215.  
  216.  
  217.  
  218.